<div class="well well-small api-menu">
	<?php $this->widget('ApiMenuWidget'); ?>
</div>
<?php
$this->beginWidget('bootstrap.widgets.TbBox', array(
	'title' => false,
	'htmlOptions' => array('class' => 'api-doc'),
));
?>

<h2>API 总述</h2>
<p>
	为便于其它开发语言使用 <code>xunsearch</code>，特提供此套 api，正在不断完善中。<br />
	相关讨论、BUG 报告以及各种开发语言的实现代码分享，请到<a href="http://bbs.xunsearch.com" target="_blank">我们的论坛</a>。
</p>

<h4>请求、响应方式</h4>
<p>POST 请求，JSON 响应。</p>

<h4>授权</h4>
<p>使用 <code>access_token</code> 授权，必须先<?php echo CHtml::link('登录', array('api/login')); ?>。</p>

<h4>成功返回</h4>
<p>有效的 JSON 数据，通常会包含布尔型的 'result' 表示成功或失败。</p>

<h4>出错情况</h4>
<p>出错时 HTTP 的响应状态码为 200 以外的数值，常见含义如下：</p>

<table class="table table-bordered">
	<tr><th>HTTP 状态</th><th>出错说明</th></tr>
	<tr>
		<td>401</td>
		<td>提供的 <code>access_token</code> 无效或已过期。</td>
	</tr>
	<tr>
		<td>403</td>
		<td>无权限，提供的 <code>access_token</code> 无效或已过期，请重新<?php echo CHtml::link('登入授权', array('api/login')); ?>。</td>
	</tr>
	<tr>
		<td>500</td>
		<td>内部错误，通常是程序或数据库出错。</td>		
	</tr>
</table>

<?php $this->endWidget();?>
